Operation Document.Filter (Filter List)
In component org.nuxeo.ecm.core.automation.coreContrib
Description
Filter the input list of documents given a condition. The condition can be expressed using 4 parameters: types, facets, lifecycle and condition. If more than one parameter is specified an AND will be used to group conditions.
The 'types' parameter can take a comma separated list of document type: File,Note.
The 'facet' parameter can take a single facet name.
The 'life cycle' parameter takes a name of a life cycle state the document should have.
The 'condition' parameter can take any EL expression.
The 'types' parameter can take a comma separated list of document type: File,Note.
The 'facet' parameter can take a single facet name.
The 'life cycle' parameter takes a name of a life cycle state the document should have.
The 'condition' parameter can take any EL expression.
Returns the list of documents that match the filter condition.
| Operation id | Document.Filter |
|---|---|
| Category | Document |
| Label | Filter List |
| Requires | |
| Since |
Parameters
| Name | Description | Type | Required | Default value |
|---|---|---|---|---|
| class | string | no | Any, Regular Document, Document Link, Published Document, Document Proxy, Document Version, Immutable Document, Mutable Document | |
| condition | string | no | ||
| facet | string | no | ||
| lifecycle | string | no | ||
| pathStartsWith | string | no | ||
| types | string | no |
Signature
| Inputs | documents |
|---|---|
| Outputs | documents |
Implementation Information
| Implementation Class | Class: org.nuxeo.ecm.automation.core.operations.document.FilterDocuments |
|---|---|
| Contributing Component | org.nuxeo.ecm.core.automation.coreContrib |
JSON Definition
{
"id" : "Document.Filter",
"label" : "Filter List",
"category" : "Document",
"requires" : null,
"description" : "Filter the input list of documents given a condition. The condition can be expressed using 4 parameters: types, facets, lifecycle and condition. If more than one parameter is specified an AND will be used to group conditions. <br>The 'types' parameter can take a comma separated list of document type: File,Note.<br>The 'facet' parameter can take a single facet name.<br> The 'life cycle' parameter takes a name of a life cycle state the document should have.<br>The 'condition' parameter can take any EL expression.<p>Returns the list of documents that match the filter condition.",
"url" : "Document.Filter",
"signature" : [ "documents", "documents" ],
"params" : [ {
"name" : "class",
"description" : null,
"type" : "string",
"required" : false,
"widget" : "Option",
"order" : 0,
"values" : [ "Any", "Regular Document", "Document Link", "Published Document", "Document Proxy", "Document Version", "Immutable Document", "Mutable Document" ]
}, {
"name" : "condition",
"description" : null,
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "facet",
"description" : null,
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "lifecycle",
"description" : null,
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "pathStartsWith",
"description" : null,
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
}, {
"name" : "types",
"description" : null,
"type" : "string",
"required" : false,
"widget" : null,
"order" : 0,
"values" : [ ]
} ]
}